Clickx 13/Clickx 13.iso/pc/UpToByte/HTMLKitSetup.exe/{app}/Bin/hkpcore.pm

Text File | 2001-04-02 | 31.3 KB | 882 lines

#
#   HTML-Kit Plugins API 1.0.19
#   Copyright (C) 1998-2000, Chami.com and Chaminda Wickremasinghe.
#   All Rights Reserved.
#
#
#   HKPAPI Reference:
#     http://www.chami.com/html-kit/devref/
#
#   HTML-Kit Developer Tools:
#     http://www.chami.com/html-kit/devtools/
#
#   Sample Plugins:
#     http://www.chami.com/html-kit/plugins/#devfiles
#


use OLE;




# Constants

$hkp_c_HKPAPI_VER              = '1.0.19';
$hkp_c_URL_HOME                = 'http://www.chami.com/html-kit/';
$hkp_c_URL_DOWNLOAD            = 'http://www.chami.com/html-kit/plugins/';

$hkp_c_str_TRUE                = '1';
$hkp_c_str_FALSE               = '0';
$hkp_c_TRUE                    = 1;
$hkp_c_FALSE                   = 0;

$hkp_c_OLEObj_HKPCore          = 'htmlkit.HTMLKitPluginsCore';

$hkp_c_CaseDefault             = 0;
$hkp_c_CaseLower               = 1;
$hkp_c_CaseUpper               = 2;

$hkp_c_QuoteDefault            = 0;
$hkp_c_QuoteSingle             = 1;
$hkp_c_QuoteDouble             = 2;

$hkp_c_ColorDefault            = 0;
$hkp_c_ColorHex6               = 1;
$hkp_c_ColorName               = 2;
$hkp_c_ColorHex3               = 3;
$hkp_c_ColorRGB                = 4;
$hkp_c_ColorRGBPercent         = 5;

$hkp_c_ETETDefault             = 0;
$hkp_c_ETETInclSpc             = 1;
$hkp_c_ETETExclSpc             = 2;

$hkp_c_EqualDefault            = 0;
$hkp_c_EqualSpaceNone          = 1;
$hkp_c_EqualSpaceLeft          = 2;
$hkp_c_EqualSpaceRight         = 3;
$hkp_c_EqualSpaceBoth          = 4;

$hkp_c_SpaceOptDefault         = 0;
$hkp_c_SpaceOptInclude         = 1;
$hkp_c_SpaceOptExclude         = 2;

$hkp_c_NewLineOptDefault       = 0;
$hkp_c_NewLineOptInclude       = 1;
$hkp_c_NewLineOptExclude       = 2;

$hkp_c_FormatTag_Token         = '^';
$hkp_c_FormatTag_NormalText    = 'N';
$hkp_c_FormatTag_Tag           = 'T';
$hkp_c_FormatTag_Attr          = 'A';
$hkp_c_FormatTag_Value         = 'V';
$hkp_c_FormatTag_Entity        = 'E';
$hkp_c_FormatTag_Event         = 'S';
$hkp_c_FormatTag_Property      = 'P';
$hkp_c_FormatTag_Color         = 'C';
$hkp_c_FormatTag_ColorExt      = 'c';
$hkp_c_FormatTag_QuoteReq      = 'Q';
$hkp_c_FormatTag_QuoteOpt      = 'q';
$hkp_c_FormatTag_ETETReq       = 'Z';
$hkp_c_FormatTag_ETETOpt       = 'z';
$hkp_c_FormatTag_Equal         = 'U';
$hkp_c_FormatTag_SpaceOpt      = 'o';
$hkp_c_FormatTag_NewLineOpt    = 'l';

$hkp_c_str_DefaultQuote        = '"';
$hkp_c_chr_DefaultQuote        = '"';

$hkp_c_str_ETETInclSpc         = ' /';
$hkp_c_str_ETETExclSpc         = '/';
$hkp_c_str_DefaultETET         = ' /';

$hkp_c_str_DefaultEqual        = '=';
$hkp_c_chr_DefaultEqual        = '=';

$hkp_c_str_DefaultSpaceOpt     = ' ';
$hkp_c_chr_DefaultSpaceOpt     = ' ';

$hkp_c_str_DefaultNewLineOpt   = '\n';
$hkp_c_chr_DefaultNewLineOpt   = '\n';


# Section names

$hkp_c_Section_Objects         = 'Objects';
$hkp_c_Section_Validators      = 'Validators';
$hkp_c_Section_Converters      = 'Converters';
$hkp_c_Section_Tables          = 'Tables';
$hkp_c_Section_Forms           = 'Forms';
$hkp_c_Section_Formats         = 'Formats';
$hkp_c_Section_Documents       = 'Document';
$hkp_c_Section_Style           = 'Style';
$hkp_c_Section_Tools           = 'Tools';
$hkp_c_Section_Text            = 'Text';
$hkp_c_Section_Common          = 'Common';
$hkp_c_Section_Invisibles      = 'Invisibles';
$hkp_c_Section_Online          = 'Online';


# Parameters

$hkp_NAME                      = 'NAME';
$hkp_VERSION                   = 'VERSION';
$hkp_SECTION                   = 'SECTION';


$hkp_DESCRIPTION               = 'DESCRIPTION';
$hkp_HINT                      = 'HINT';
$hkp_ICON_LARGE                = 'ICON_LARGE';
$hkp_ICON_SMALL                = 'ICON_SMALL';
$hkp_COPYRIGHT_SHORT           = 'COPYRIGHT_SHORT';
$hkp_COPYRIGHT_LONG            = 'COPYRIGHT_LONG';


$hkp_HELP_FILE                 = 'HELP_FILE';
$hkp_HELP_CONTEXT              = 'HELP_CONTEXT';
$hkp_HOTKEY                    = 'HOTKEY';
$hkp_ICON_CAPTION              = 'ICON_CAPTION';
$hkp_ENABLED                   = 'ENABLED';
$hkp_MENU_CAPTION              = 'MENU_CAPTION';
$hkp_AUTHOR                    = 'AUTHOR';
$hkp_PHONE                     = 'PHONE';
$hkp_COMPANY                   = 'COMPANY';
$hkp_MAILING_ADDRESS           = 'MAILING_ADDRESS';
$hkp_EMAIL                     = 'EMAIL';
$hkp_URL_HOME                  = 'URL_HOME';
$hkp_URL_DOWNLOAD              = 'URL_DOWNLOAD';
$hkp_MENU_ITEM1                = 'MENU_ITEM1';
$hkp_MENU_ITEM2                = 'MENU_ITEM2';
$hkp_MENU_ITEM3                = 'MENU_ITEM3';
$hkp_MENU_ITEM4                = 'MENU_ITEM4';
$hkp_MENU_ITEM5                = 'MENU_ITEM5';
$hkp_DROPDOWN_ITEM             = 'DROPDOWN_ITEM';
$hkp_DROPDOWN_ITEM_HINT        = 'DROPDOWN_ITEM_HINT';
$hkp_DROPDOWN_ITEM_ICON        = 'DROPDOWN_ITEM_ICON';
$hkp_ARGV1                     = 'ARGV1';
$hkp_ARGV2                     = 'ARGV2';
$hkp_ARGV3                     = 'ARGV3';
$hkp_ARGV4                     = 'ARGV4';
$hkp_ARGV5                     = 'ARGV5';
$hkp_EVENT                     = 'EVENT';
$hkp_COMMAND_BUILTIN           = 'COMMAND_BUILTIN';

$hkp_MODE_CONSOLE              = 'MODE_CONSOLE';
$hkp_MODE_SHOW_STATUS          = 'MODE_SHOW_STATUS';
$hkp_MODE_IN_TEXT_FULL         = 'MODE_IN_TEXT_FULL';
$hkp_MODE_IN_TEXT_SELECTED     = 'MODE_IN_TEXT_SELECTED';
$hkp_MODE_IN_WORD_AT_CURSOR    = 'MODE_IN_WORD_AT_CURSOR';
$hkp_MODE_IN_TAG_AT_CURSOR     = 'MODE_IN_TAG_AT_CURSOR';
$hkp_MODE_IN_LINE_AT_CURSOR    = 'MODE_IN_LINE_AT_CURSOR';
$hkp_MODE_IN_FILE              = 'MODE_IN_FILE';
$hkp_MODE_IN_FILE_EXT          = 'MODE_IN_FILE_EXT';
$hkp_MODE_IN_FILE_DELETE       = 'MODE_IN_FILE_DELETE';
$hkp_MODE_MOVE_TO_CARET        = 'MODE_MOVE_TO_CARET';
$hkp_MODE_PREPROCESS           = 'MODE_PREPROCESS';
$hkp_MODE_SAVE_FIRST           = 'MODE_SAVE_FIRST';
$hkp_MODE_DEBUG_PLUGIN         = 'MODE_DEBUG_PLUGIN';
$hkp_MODE_ADD_MENU_SHORTCUTS   = 'MODE_ADD_MENU_SHORTCUTS';
$hkp_MODE_PREPROCESS_FORMAT_TAGS = 'MODE_PREPROCESS_FORMAT_TAGS';
$hkp_MODE_BEGIN_GROUP          = 'MODE_BEGIN_GROUP';
$hkp_MODE_END_GROUP            = 'MODE_END_GROUP';
$hkp_MODE_APPEARANCE_ICONS     = 'MODE_APPEARANCE_ICONS';
$hkp_MODE_EDITOR_REQUIRED      = 'MODE_EDITOR_REQUIRED';
$hkp_MODE_FOCUS_EDITOR         = 'MODE_FOCUS_EDITOR';
$hkp_MODE_EGG                  = 'MODE_EGG';

$hkp_c_Button_Event_OnClick        = 1;
$hkp_c_Menu_Event_OnClick          = 10;

$hkp_LABEL_VISIBLE             = 'LABEL_VISIBLE';
$hkp_LABEL_WIDTH               = 'LABEL_WIDTH';
$hkp_LABEL_WIDTH_CHAR          = 'LABEL_WIDTH_CHAR';
$hkp_LABEL_HINT                = 'LABEL_HINT';
$hkp_LABEL_TEXT                = 'LABEL_TEXT';
$hkp_LABEL_ALIGNMENT           = 'LABEL_ALIGNMENT';
$hkp_LABEL_STYLE               = 'LABEL_STYLE';
$hkp_LABEL_DIRTY               = 'LABEL_DIRTY';
$hkp_LABEL_HANDLE              = 'LABEL_HANDLE';
$hkp_LABEL_EVENT_ONCLICK       = 'LABEL_EVENT_ONCLICK';
$hkp_LABEL_EVENT_ONDBLCLICK    = 'LABEL_EVENT_ONDBLCLICK';
$hkp_LABEL_EVENT_ONMOUSEDOWN   = 'LABEL_EVENT_ONMOUSEDOWN';

$hkp_c_Label_Event_OnClick         = 50;
$hkp_c_Label_Event_OnDblClick      = 51;
$hkp_c_Label_Event_OnMouseDown     = 52;
$hkp_c_Label_Alignment_Left        = 95;
$hkp_c_Label_Alignment_Center      = 96;
$hkp_c_Label_Alignment_Right       = 97;
$hkp_c_Label_GetData               = 98;
$hkp_c_Label_SetData               = 99;

$hkp_COMBOBOX_VISIBLE          = 'COMBOBOX_VISIBLE';
$hkp_COMBOBOX_WIDTH            = 'COMBOBOX_WIDTH';
$hkp_COMBOBOX_WIDTH_CHAR       = 'COMBOBOX_WIDTH_CHAR';
$hkp_COMBOBOX_DROPDOWN_COUNT   = 'COMBOBOX_DROPDOWN_COUNT';
$hkp_COMBOBOX_HINT             = 'COMBOBOX_HINT';
$hkp_COMBOBOX_STYLE            = 'COMBOBOX_STYLE';
$hkp_COMBOBOX_SORTED           = 'COMBOBOX_SORTED';
$hkp_COMBOBOX_TEXT             = 'COMBOBOX_TEXT';
$hkp_COMBOBOX_CHAR_MAX         = 'COMBOBOX_CHAR_MAX';
$hkp_COMBOBOX_DIRTY            = 'COMBOBOX_DIRTY';
$hkp_COMBOBOX_HANDLE           = 'COMBOBOX_HANDLE';
$hkp_COMBOBOX_ITEMS_GET        = 'COMBOBOX_ITEMS_GET';
$hkp_COMBOBOX_ITEMS_COUNT      = 'COMBOBOX_ITEMS_COUNT';
$hkp_COMBOBOX_ITEMS_CURR_INDEX = 'COMBOBOX_ITEMS_CURR_INDEX';
$hkp_COMBOBOX_ITEMS_CURR_TEXT  = 'COMBOBOX_ITEMS_CURR_TEXT';
$hkp_COMBOBOX_ITEMS_CURR_DATA  = 'COMBOBOX_ITEMS_CURR_DATA';
$hkp_COMBOBOX_ITEMS_DELETE_ALL = 'COMBOBOX_ITEMS_DELETE_ALL';
$hkp_COMBOBOX_ITEMS_INSERT_TOP = 'COMBOBOX_ITEMS_INSERT_TOP';
$hkp_COMBOBOX_ITEMS_IGNORE_DUPLICATES = 'COMBOBOX_ITEMS_IGNORE_DUPLICATES';
$hkp_COMBOBOX_ITEM             = 'COMBOBOX_ITEM';
$hkp_COMBOBOX_ITEM_DATA        = 'COMBOBOX_ITEM_DATA';
$hkp_COMBOBOX_EVENT_ONCHANGE   = 'COMBOBOX_EVENT_ONCHANGE';
$hkp_COMBOBOX_EVENT_ONDROPDOWN = 'COMBOBOX_EVENT_ONDROPDOWN';
$hkp_COMBOBOX_EVENT_ONCLICK    = 'COMBOBOX_EVENT_ONCLICK';
$hkp_COMBOBOX_EVENT_ONKEYPRESS = 'COMBOBOX_EVENT_ONKEYPRESS';
$hkp_COMBOBOX_EVENT_ONMOUSEDOWN = 'COMBOBOX_EVENT_ONMOUSEDOWN';
$hkp_COMBOBOX_KEYPRESS_FILTER  = 'COMBOBOX_KEYPRESS_FILTER';

$hkp_c_ComboBox_Event_OnChange     = 100;
$hkp_c_ComboBox_Event_OnDropDown   = 101;
$hkp_c_ComboBox_Event_OnClick      = 102;
$hkp_c_ComboBox_Event_OnKeyPress   = 103;
$hkp_c_ComboBox_Event_OnMouseDown  = 104;
$hkp_c_ComboBox_GetData            = 145;
$hkp_c_ComboBox_SetData            = 146;
$hkp_c_ComboBox_Style_DropDown     = 147;
$hkp_c_ComboBox_Style_DropDownList = 148;
$hkp_c_ComboBox_Style_Simple       = 149;

$hkp_EDITFIELD_VISIBLE         = 'EDITFIELD_VISIBLE';
$hkp_EDITFIELD_WIDTH           = 'EDITFIELD_WIDTH';
$hkp_EDITFIELD_WIDTH_CHAR      = 'EDITFIELD_WIDTH_CHAR';
$hkp_EDITFIELD_HINT            = 'EDITFIELD_HINT';
$hkp_EDITFIELD_TEXT            = 'EDITFIELD_TEXT';
$hkp_EDITFIELD_CHAR_MAX        = 'EDITFIELD_CHAR_MAX';
$hkp_EDITFIELD_DIRTY           = 'EDITFIELD_DIRTY';
$hkp_EDITFIELD_HANDLE          = 'EDITFIELD_HANDLE';
$hkp_EDITFIELD_EVENT_ONCHANGE  = 'EDITFIELD_EVENT_ONCHANGE';
$hkp_EDITFIELD_EVENT_ONKEYPRESS = 'EDITFIELD_EVENT_ONKEYPRESS';
$hkp_EDITFIELD_EVENT_ONMOUSEDOWN = 'EDITFIELD_EVENT_ONMOUSEDOWN';
$hkp_EDITFIELD_KEYPRESS_FILTER = 'EDITFIELD_KEYPRESS_FILTER';

$hkp_c_EditField_Event_OnChange    = 150;
$hkp_c_EditField_Event_OnKeyPress  = 151;
$hkp_c_EditField_Event_OnMouseDown = 152;
$hkp_c_EditField_GetData           = 198;
$hkp_c_EditField_SetData           = 199;

$hkp_c_MODE_ICON_RES           = 0;
$hkp_c_MODE_ICON_DATA          = 1;
$hkp_c_MODE_ICON_FILE          = 2;
$hkp_c_MODE_ICON_BUILTIN       = 3;
$hkp_MODE_ICON                 = 'MODE_ICON';

$hkp_c_MODE_OUTPUT_DEFAULT     = 0;
$hkp_c_MODE_OUTPUT_CURRENTPOS  = 1;
$hkp_c_MODE_OUTPUT_SELECTION   = 2;
$hkp_c_MODE_OUTPUT_POPUP       = 3;
$hkp_c_MODE_OUTPUT_CURRENTWORD = 4;
$hkp_c_MODE_OUTPUT_CURRENTTAG  = 5;
$hkp_c_MODE_OUTPUT_EDITOR      = 6;
$hkp_c_MODE_OUTPUT_EDITOR_NEW  = 7;
$hkp_c_MODE_OUTPUT_CURRENTLINE = 8;
$hkp_MODE_OUTPUT               = 'MODE_OUTPUT';

$hkp_c_MODE_PLUGIN_CACHE_NONE  = 0;
$hkp_c_MODE_PLUGIN_CACHE_ALL   = 1;
$hkp_MODE_PLUGIN_CACHE         = 'MODE_PLUGIN_CACHE';

$hkp_PLUGIN_NAME               = 'P_NAME';
$hkp_PLUGIN_ID                 = 'P_ID';
$hkp_PLUGIN_TAG                = 'P_TAG';
$hkp_PLUGIN_FILE               = 'PLUGIN_FILE';
$hkp_FILE_DISP_NAME            = 'FILE_DISP_NAME';
$hkp_FILE_DISP_NAME_SHORT      = 'FILE_DISP_NAME_SHORT';
$hkp_FILE_NAME                 = 'FILE_NAME';
$hkp_FILE_NAME_SHORT           = 'FILE_NAME_SHORT';
$hkp_FILE_MODIFIED             = 'FILE_MODIFIED';
$hkp_INPUT                     = 'INPUT';
$hkp_INPUT_SELECTED            = 'INPUT_SELECTION';
$hkp_INPUT_WORD_AT_CURSOR      = 'INPUT_WORD_AT_CURSOR';
$hkp_INPUT_TAG_AT_CURSOR       = 'INPUT_TAG_AT_CURSOR';
$hkp_INPUT_LINE_AT_CURSOR      = 'INPUT_LINE_AT_CURSOR';
$hkp_INPUT_FILE                = 'INPUT_FILE';
$hkp_OUTPUT                    = 'OUTPUT';

$hkp_APPEARANCE_NAME           = 'APPEARANCE_NAME';

$hkp_NAME_LONG                 = 'NAME_LONG';
$hkp_VER_MAJOR                 = 'VER_MAJOR';
$hkp_VER_MINOR                 = 'VER_MINOR';
$hkp_VER_RELEASE               = 'VER_RELEASE';
$hkp_VER_BUILD                 = 'VER_BUILD';
$hkp_VER_TIMESTAMP             = 'VER_TIMESTAMP';
$hkp_VER_TYPE                  = 'VER_TYPE';
$hkp_VER_RELEASE_ID            = 'VER_RELEASE_ID';
$hkp_VER                       = 'VER';
$hkp_HKPAPI_VER                = 'HKPAPI_VER';

$hkp_INCOMPATIBLE              = 'INCOMPATIBLE';

$hkp_OWNER_WINDOW_HANDLE       = 'OWNER_WINDOW_HANDLE';
$hkp_EDITOR_WINDOW_HANDLE      = 'EDITOR_WINDOW_HANDLE';
$hkp_PROGRAM_HANDLE            = 'PROGRAM_HANDLE';
$hkp_EDITOR_AVAILABLE          = 'EDITOR_AVAILABLE';

$hkp_PREF_SHORT_MENUS          = 'PREF_SHORT_MENUS';
$hkp_PREF_MENU_HEIGHT          = 'PREF_MENU_HEIGHT';

$hkp_PREF_CASE_TAG             = 'PREF_CASE_TAG';
$hkp_PREF_CASE_ATTR            = 'PREF_CASE_ATTR';
$hkp_PREF_CASE_VALUE           = 'PREF_CASE_VALUE';
$hkp_PREF_CASE_ENTITY          = 'PREF_CASE_ENTITY';
$hkp_PREF_CASE_EVENT           = 'PREF_CASE_EVENT';
$hkp_PREF_CASE_PROPERTY        = 'PREF_CASE_PROPERTY';
$hkp_PREF_FORMAT_COLOR         = 'PREF_FORMAT_COLOR';
$hkp_PREF_FORMAT_QUOTE         = 'PREF_FORMAT_QUOTE';
$hkp_PREF_FORMAT_QUOTE_SKIP_OPTIONAL = 'PREF_FORMAT_QUOTE_SKIP_OPTIONAL';
$hkp_PREF_FORMAT_ETET          = 'PREF_FORMAT_ETET';
$hkp_PREF_FORMAT_ETET_SKIP_OPTIONAL = 'PREF_FORMAT_ETET_SKIP_OPTIONAL';
$hkp_PREF_FORMAT_EQUAL         = 'PREF_FORMAT_EQUAL';
$hkp_PREF_FORMAT_SPACE         = 'PREF_FORMAT_SPACE';
$hkp_PREF_FORMAT_NEWLINE       = 'PREF_FORMAT_NEWLINE';

$hkp_PREF_AUTHOR_NAME          = 'PREF_AUTHOR_NAME';
$hkp_PREF_AUTHOR_COMPANY       = 'PREF_AUTHOR_COMPANY';
$hkp_PREF_AUTHOR_WEBSITE       = 'PREF_AUTHOR_WEBSITE';
$hkp_PREF_AUTHOR_EMAIL         = 'PREF_AUTHOR_EMAIL';
$hkp_PREF_AUTHOR_COMMENTS      = 'PREF_AUTHOR_COMMENTS';

$hkp_PREF_DATETIME_FORMAT      = 'PREF_DATETIME_FORMAT';

$hkp_FILE_TYPE_FILTER_DOCS     = 'FILE_TYPE_FILTER_DOCS';
$hkp_FILE_TYPE_FILTER_IMAGES   = 'FILE_TYPE_FILTER_IMAGES';
$hkp_FILE_TYPE_FILTER_DEFAULT  = 'FILE_TYPE_FILTER_DEFAULT';

$hkp_PATH_ROOT                 = 'PATH_ROOT';
$hkp_PATH_PLUGINS              = 'PATH_PLUGINS';
$hkp_PATH_LAST_OPEN            = 'PATH_LAST_OPEN';
$hkp_PATH_LAST_SAVE            = 'PATH_LAST_SAVE';
$hkp_PATH_SNIPPETS_DEFAULT     = 'PATH_SNIPPETS_DEFAULT';
$hkp_PATH_TEMPLATES_DEFAULT    = 'PATH_TEMPLATES_DEFAULT';
$hkp_PATH_SNIPPETS_USER        = 'PATH_SNIPPETS_USER';
$hkp_PATH_TEMPLATES_USER       = 'PATH_TEMPLATES_USER';
$hkp_PATH_PLUGINS_CONFIG       = 'PATH_PLUGINS_CONFIG';
$hkp_PATH_BACKUP               = 'PATH_BACKUP';
$hkp_PATH_CACHE                = 'PATH_CACHE';
$hkp_PATH_DATA                 = 'PATH_DATA';
$hkp_PATH_DATA_DEFAULT         = 'PATH_DATA_DEFAULT';
$hkp_PATH_HELP                 = 'PATH_HELP';
$hkp_PATH_HELP_KEYWORDS        = 'PATH_HELP_KEYWORDS';
$hkp_PATH_HELP_CONTENT         = 'PATH_HELP_CONTENT';
$hkp_PATH_PROOF                = 'PATH_PROOF';
$hkp_PATH_TEMP                 = 'PATH_TEMP';
$hkp_PATH_BIN                  = 'PATH_BIN';

$hkp_PROXY_ADDRESS             = 'PROXY_ADDRESS';
$hkp_PROXY_PORT                = 'PROXY_PORT';
$hkp_PROXY_USERNAME            = 'PROXY_USERNAME';
$hkp_PROXY_PASSWORD            = 'PROXY_PASSWORD';


# hkp_Func*() related definitions

$hkp_FUNC_NAME                 = 'FUNC_NAME';
$hkp_FUNC_DEFINED              = 'FUNC_DEFINED';
$hkp_FUNC_P1                   = 'FUNC_PARAM1';
$hkp_FUNC_P2                   = 'FUNC_PARAM2';
$hkp_FUNC_P3                   = 'FUNC_PARAM3';
$hkp_FUNC_P4                   = 'FUNC_PARAM4';
$hkp_FUNC_P5                   = 'FUNC_PARAM5';
$hkp_FUNC_P6                   = 'FUNC_PARAM6';
$hkp_FUNC_P7                   = 'FUNC_PARAM7';
$hkp_FUNC_P8                   = 'FUNC_PARAM8';
$hkp_FUNC_P9                   = 'FUNC_PARAM9';

$hkp_f_GetCurrDateTimeFmt      = 'GetCurrDateTimeFmt';
$hkp_f_GetUniqueName           = 'GetUniqueName';
$hkp_f_SaveToTempFile          = 'SaveToTempFile';
$hkp_f_SaveToFile              = 'SaveToFile';
$hkp_f_LoadFromFile            = 'LoadFromFile';
$hkp_f_ShellExecute            = 'ShellExecute';
$hkp_f_DDEExecute              = 'DDEExecute';
$hkp_f_ExecuteAndWait          = 'ExecuteAndWait';
$hkp_f_httpPostMPFD            = 'httpPostMPFD';
$hkp_f_OpenBrowser             = 'OpenBrowser';
$hkp_f_GetTempFileName         = 'GetTempFileName';
$hkp_f_GetTempFileNameExt      = 'GetTempFileNameExt';
$hkp_f_regexSplitExt           = 'regexSplitExt';
$hkp_f_regexFound              = 'regexFound';
$hkp_f_regexGather             = 'regexGather';
$hkp_f_regexReplace            = 'regexReplace';
$hkp_f_statbarPushMsg          = 'statbarPushMsg';
$hkp_f_statbarPopMsg           = 'statbarPopMsg';
$hkp_f_msgwinClearAll          = 'msgwinClearAll';
$hkp_f_msgwinAdd               = 'msgwinAdd';
$hkp_f_cmndlgOpen              = 'cmndlgOpen';
$hkp_f_cmndlgSave              = 'cmndlgSave';
$hkp_f_fileGetSize             = 'fileGetSize';
$hkp_f_jpgGetImageInfo         = 'jpgGetImageInfo';
$hkp_f_gifGetImageInfo         = 'gifGetImageInfo';
$hkp_f_pngGetImageInfo         = 'pngGetImageInfo';
$hkp_f_CaseTag                 = 'CaseTag';
$hkp_f_CaseAttr                = 'CaseAttr';
$hkp_f_CaseValue               = 'CaseValue';
$hkp_f_CaseEntity              = 'CaseEntity';
$hkp_f_CaseEvent               = 'CaseEvent';
$hkp_f_CaseProperty            = 'CaseProperty';
$hkp_f_FormatQuote             = 'FormatQuote';
$hkp_f_FormatColor             = 'FormatColor';
$hkp_f_HKPEnableFastAdd        = 'HKPEnableFastAdd';
$hkp_f_InvokeMenuCommandByCaption  = 'InvokeMenuCommandByCaption';
$hkp_f_GetColor                = 'GetColor';
$hkp_f_Unformat                = 'Unformat';
$hkp_f_InvokeCommand           = 'InvokeCommand';
$hkp_f_UI_GetFileName          = 'UI_GetFileName';
$hkp_f_PluginDataWrite         = 'PluginDataWrite';
$hkp_f_PluginDataRead          = 'PluginDataRead';
$hkp_f_GetStyleCSS             = 'GetStyleCSS';
$hkp_f_OpenFileEx              = 'OpenFileEx';
$hkp_f_NewFile                 = 'NewFile';
$hkp_f_FormatETET              = 'FormatETET';
$hkp_f_GetCursorXY             = 'GetCursorXY';
$hkp_f_SetCursorXY             = 'SetCursorXY';
$hkp_f_GetMarks                = 'GetMarks';
$hkp_f_SetMarks                = 'SetMarks';
$hkp_f_GetOpenFilesList        = 'GetOpenFilesList';
$hkp_f_GetSetFileContent       = 'GetSetFileContent';
$hkp_f_PluginCacheClear        = 'PluginCacheClear';
$hkp_f_TextToFile              = 'TextToFile';
$hkp_f_Progress                = 'Progress';
$hkp_f_FormatEqual             = 'FormatEqual';
$hkp_f_FormatSpaceOpt          = 'FormatSpaceOpt';
$hkp_f_FormatNewLineOpt        = 'FormatNewLineOpt';
$hkp_f_ShowHelp                = 'ShowHelp';
$hkp_f_GetCalc                 = 'GetCalc';
$hkp_f_urlGetRelPath           = 'urlGetRelPath';
$hkp_f_ProcessToken            = 'ProcessToken';
$hkp_f_URL2File                = 'URL2File';


# Parameters used to report progress

$hkp_STATUS_LINES_IN_CURRENT   = 'STATUS_LINES_IN_CURRENT';
$hkp_STATUS_LINES_IN_TOTAL     = 'STATUS_LINES_IN_TOTAL';
$hkp_STATUS_LINES_OUT_CURRENT  = 'STATUS_LINES_OUT_CURRENT';
$hkp_STATUS_LINES_OUT_TOTAL    = 'STATUS_LINES_OUT_TOTAL';
$hkp_STATUS_PERCENT_COMPLETED  = 'STATUS_PERCENT_COMPLETED';
$hkp_STATUS_ERRORS_COUNT       = 'STATUS_ERRORS_COUNT';
$hkp_STATUS_WARNINGS_COUNT     = 'STATUS_WARNINGS_COUNT';
$hkp_STATUS_PROGRESS_MESSAGE   = 'STATUS_PROGRESS_MESSAGE';
$hkp_STATUS_DIVIDER_LINES      = 'STATUS_DIVIDER_LINES';


# Plugin specific definitions

$hkp_c_PLUGIN_NAME_HTMLTIDY    = 'HTML Tidy';

$hkp_MODE_TIDY                 = 'MODE_TIDY';
$hkp_CONFIG_TIDY               = 'CONFIG_TIDY';
$hkp_MESSAGES_TIDY             = 'MESSAGES_TIDY';


# Obsolete definition names

$hkp_c_strTRUE                 = '1';
$hkp_c_strFALSE                = '0';

$hkp_c_DefaultQuoteStr         = '"';
$hkp_c_DefaultQuoteChar        = '"';


sub hkp_CreateObjectHKPCore
{
  return CreateObject OLE $hkp_c_OLEObj_HKPCore;
}

sub hkp_reg_AddButton
{
  my($name, $section, $icon_caption, $suffix) = @_;
  my($v) = hkp_CreateObjectHKPCore();
  if($name)
  {
    $v->hkp_DataSetGlobalSuffix($suffix ? $suffix : '_1');
    $v->hkp_DataAdd('NAME', $name);
    $v->hkp_DataAdd('SECTION', $section);
    if($icon_caption)
    {
      $v->hkp_DataAdd('ICON_CAPTION', $icon_caption);
    }
    $v->hkp_DataSetGlobalSuffix('');
  }
  return $v;
}

sub hkp_run_SendToEditor
{
  my($text, $reserved) = @_;
  my($v) = hkp_CreateObjectHKPCore();
  $v->hkp_DataAddInt('MODE_OUTPUT', 1);
  $v->hkp_DataAdd('OUTPUT', ''.$text );
  return $v;
}

sub hkp_mode_register
{
  return ('-hkpreg' eq $ARGV[0]);
}

sub hkp_mode_run
{
  return ('-hkprun' eq $ARGV[0]);
}

return 1;



#
#   --- History ---
#   01-Nov-2000: Version 1.0.19 / Build 290 Alpha 11 (20001101)
#     * "renamed hkp_f_jpgGetSize to hkp_f_jpgGetImageInfo"
#     * "renamed hkp_f_gifGetSize to hkp_f_gifGetImageInfo"
#     + hkp_f_pngGetImageInfo,
#       hkp_f_URL2File,
#       hkp_MODE_IN_LINE_AT_CURSOR,
#       hkp_INPUT_LINE_AT_CURSOR,
#       hkp_c_MODE_OUTPUT_CURRENTLINE,
#       hkp_MODE_EGG
#
#   15-Jul-2000: Version 1.0.18 / Build 290 Alpha 11 (20000715)
#     * "renamed hkp_c_ColorCode to hkp_c_ColorHex6"
#     * "renamed hkp_f_jpgGetWidthHeight to hkp_f_jpgGetSize"
#     - hkp_ProcAddr_TextToFile
#     + hkp_ProcAddr_Reserved,
#       hkp_c_ColorRGB,
#       hkp_c_ColorRGBPercent,
#       hkp_c_ColorHex3,
#       hkp_c_FormatTag_ColorExt,
#       hkp_c_Section_Online,
#       hkp_c_EqualDefault,
#       hkp_c_EqualSpaceNone,
#       hkp_c_EqualSpaceLeft,
#       hkp_c_EqualSpaceRight,
#       hkp_c_EqualSpaceBoth,
#       hkp_c_SpaceOptDefault,
#       hkp_c_SpaceOptInclude,
#       hkp_c_SpaceOptExclude,
#       hkp_c_NewLineOptDefault,
#       hkp_c_NewLineOptInclude,
#       hkp_c_NewLineOptExclude,
#       hkp_c_FormatTag_Equal,
#       hkp_c_FormatTag_SpaceOpt,
#       hkp_c_FormatTag_NewLineOpt,
#       hkp_c_str_DefaultEqual,
#       hkp_c_chr_DefaultEqual,
#       hkp_c_str_DefaultSpaceOpt,
#       hkp_c_chr_DefaultSpaceOpt,
#       hkp_c_str_DefaultNewLineOpt,
#       hkp_c_chr_DefaultNewLineOpt,
#       hkp_c_str_TRUE,
#       hkp_c_str_FALSE,
#       hkp_c_str_DefaultQuote,
#       hkp_c_chr_DefaultQuote,
#       hkp_DROPDOWN_ITEM_HINT,
#       hkp_DROPDOWN_ITEM_ICON,
#       hkp_f_GetCursorXY,
#       hkp_f_SetCursorXY,
#       hkp_f_GetMarks,
#       hkp_f_SetMarks,
#       hkp_f_GetOpenFilesList,
#       hkp_f_GetSetFileContent,
#       hkp_f_PluginCacheClear,
#       hkp_f_TextToFile,
#       hkp_f_Progress,
#       hkp_f_FormatEqual,
#       hkp_f_FormatSpaceOpt,
#       hkp_f_FormatNewLineOpt,
#       hkp_f_ShowHelp,
#       hkp_f_jpgGetSize,
#       hkp_f_gifGetSize,
#       hkp_f_GetCalc,
#       hkp_f_urlGetRelPath,
#       hkp_f_ProcessToken,
#       hkp_PLUGIN_FILE,
#       hkp_PROGRAM_HANDLE,
#       hkp_VER_TIMESTAMP,
#       hkp_VER_TYPE,
#       hkp_VER_RELEASE_ID,
#       hkp_MODE_APPEARANCE_ICONS,
#       hkp_MODE_EDITOR_REQUIRED,
#       hkp_EDITOR_AVAILABLE,
#       hkp_APPEARANCE_NAME,
#       hkp_PREF_DATETIME_FORMAT,
#       hkp_MODE_END_GROUP,
#       hkp_LABEL_VISIBLE,
#       hkp_LABEL_WIDTH,
#       hkp_LABEL_WIDTH_CHAR,
#       hkp_LABEL_HINT,
#       hkp_LABEL_TEXT,
#       hkp_LABEL_ALIGNMENT,
#       hkp_LABEL_STYLE,
#       hkp_LABEL_DIRTY,
#       hkp_LABEL_HANDLE,
#       hkp_LABEL_EVENT_ONCLICK,
#       hkp_LABEL_EVENT_ONDBLCLICK,
#       hkp_LABEL_EVENT_ONMOUSEDOWN,
#       hkp_COMBOBOX_VISIBLE,
#       hkp_COMBOBOX_WIDTH,
#       hkp_COMBOBOX_WIDTH_CHAR,
#       hkp_COMBOBOX_DROPDOWN_COUNT,
#       hkp_COMBOBOX_HINT,
#       hkp_COMBOBOX_STYLE,
#       hkp_COMBOBOX_SORTED,
#       hkp_COMBOBOX_TEXT,
#       hkp_COMBOBOX_CHAR_MAX,
#       hkp_COMBOBOX_DIRTY,
#       hkp_COMBOBOX_HANDLE,
#       hkp_COMBOBOX_ITEMS_GET,
#       hkp_COMBOBOX_ITEMS_COUNT,
#       hkp_COMBOBOX_ITEMS_CURR_INDEX,
#       hkp_COMBOBOX_ITEMS_CURR_TEXT,
#       hkp_COMBOBOX_ITEMS_CURR_DATA,
#       hkp_COMBOBOX_ITEMS_DELETE_ALL,
#       hkp_COMBOBOX_ITEMS_INSERT_TOP,
#       hkp_COMBOBOX_ITEMS_IGNORE_DUPLICATES,
#       hkp_COMBOBOX_ITEM,
#       hkp_COMBOBOX_ITEM_DATA,
#       hkp_COMBOBOX_EVENT_ONCHANGE,
#       hkp_COMBOBOX_EVENT_ONDROPDOWN,
#       hkp_COMBOBOX_EVENT_ONCLICK,
#       hkp_COMBOBOX_EVENT_ONKEYPRESS,
#       hkp_COMBOBOX_EVENT_ONMOUSEDOWN,
#       hkp_COMBOBOX_KEYPRESS_FILTER,
#       hkp_EDITFIELD_VISIBLE,
#       hkp_EDITFIELD_WIDTH,
#       hkp_EDITFIELD_WIDTH_CHAR,
#       hkp_EDITFIELD_HINT,
#       hkp_EDITFIELD_TEXT,
#       hkp_EDITFIELD_CHAR_MAX,
#       hkp_EDITFIELD_DIRTY,
#       hkp_EDITFIELD_HANDLE,
#       hkp_EDITFIELD_EVENT_ONCHANGE,
#       hkp_EDITFIELD_EVENT_ONKEYPRESS,
#       hkp_EDITFIELD_EVENT_ONMOUSEDOWN,
#       hkp_EDITFIELD_KEYPRESS_FILTER,
#       hkp_c_Button_Event_OnClick,
#       hkp_c_Menu_Event_OnClick,
#       hkp_c_Label_Event_OnClick,
#       hkp_c_Label_Event_OnDblClick,
#       hkp_c_Label_Event_OnMouseDown,
#       hkp_c_Label_Alignment_Left,
#       hkp_c_Label_Alignment_Center,
#       hkp_c_Label_Alignment_Right,
#       hkp_c_Label_GetData,
#       hkp_c_Label_SetData,
#       hkp_c_ComboBox_Event_OnChange,
#       hkp_c_ComboBox_Event_OnDropDown,
#       hkp_c_ComboBox_Event_OnClick,
#       hkp_c_ComboBox_Event_OnKeyPress,
#       hkp_c_ComboBox_Event_OnMouseDown,
#       hkp_c_ComboBox_Style_DropDown,
#       hkp_c_ComboBox_Style_DropDownList,
#       hkp_c_ComboBox_Style_Simple,
#       hkp_c_ComboBox_GetData,
#       hkp_c_ComboBox_SetData,
#       hkp_c_EditField_Event_OnChange,
#       hkp_c_EditField_Event_OnKeyPress,
#       hkp_c_EditField_Event_OnMouseDown,
#       hkp_c_EditField_GetData,
#       hkp_c_EditField_SetData,
#       hkp_MODE_FOCUS_EDITOR,
#       hkp_ARGV2,
#       hkp_ARGV3,
#       hkp_ARGV4,
#       hkp_ARGV5,
#       hkp_EVENT,
#       HKP_UINT16,
#       HKP_INT32,
#       HKP_INT64
#
#   10-Jun-2000: Version 1.0.17 / Build 290 Alpha 11 (20000701)
#     + hkp_c_OLEObj_HKPCore
#
#   10-Jun-2000: Version 1.0.16 / Build 290 Alpha 11 (20000610)
#     + hkp_PATH_SNIPPETS_DEFAULT,
#       hkp_PATH_TEMPLATES_DEFAULT,
#       hkp_PATH_SNIPPETS_USER,
#       hkp_PATH_TEMPLATES_USER,
#       hkp_PATH_PLUGINS_CONFIG,
#       hkp_PATH_BACKUP,
#       hkp_PATH_CACHE,
#       hkp_PATH_DATA,
#       hkp_PATH_DATA_DEFAULT,
#       hkp_PATH_HELP,
#       hkp_PATH_HELP_KEYWORDS,
#       hkp_PATH_HELP_CONTENT,
#       hkp_PATH_PROOF,
#       hkp_PATH_TEMP,
#       hkp_PATH_BIN,
#       hkp_c_FormatTag_ETET,
#       hkp_c_ETETDefault,
#       hkp_c_ETETInclSpc,
#       hkp_c_ETETExclSpc,
#       hkp_c_str_ETETInclSpc,
#       hkp_c_str_ETETExclSpc,
#       hkp_f_FormatETET,
#       hkp_PREF_FORMAT_ETET,
#       hkp_PREF_FORMAT_ETET_SKIP_OPTIONAL
#
#   29-Apr-2000: Version 1.0.15 / Build 290 Beta 10
#     + hkp_MODE_PLUGIN_CACHE,
#       hkp_c_MODE_PLUGIN_CACHE_NONE,
#       hkp_c_MODE_PLUGIN_CACHE_ALL,
#       hkp_c_MODE_ICON_BUILTIN,
#       hkp_c_Section_Style,
#       hkp_EDITOR_WINDOW_HANDLE,
#       hkp_f_UI_GetFileName,
#       hkp_f_PluginDataWrite,
#       hkp_f_PluginDataRead,
#       hkp_f_GetStyleCSS,
#       hkp_f_OpenFileEx,
#       hkp_f_NewFile,
#       hkp_COMMAND_BUILTIN
#     * "Changed default value for hkp_MODE_SHOW_STATUS to hkp_c_FALSE"
#     * "Set default value for hkp_MODE_CONSOLE to hkp_c_strTRUE"
#     * "Set default value for hkp_MODE_PLUGIN_CACHE to hkp_c_MODE_PLUGIN_CACHE_ALL"
#
#   30-Mar-2000: Version 1.0.14 / Build 290 Beta 9
#     + hkp_c_MODE_OUTPUT_EDITOR_NEW,
#       hkp_f_InvokeCommand
#
#   13-Feb-2000: Version 1.0.13 / Build 290 Beta 8
#     + hkp_MODE_BEGIN_GROUP
#
#   03-Feb-2000: Version 1.0.12 / Build 290 Beta 7
#     + hkp_FILE_DISP_NAME,
#       hkp_FILE_DISP_NAME_SHORT
#
#   05-Dec-1999: Version 1.0.11 / Build 286
#     + hkp_f_HKPEnableFastAdd,
#       hkp_f_InvokeMenuCommandByCaption,
#       hkp_f_FormatColor,
#       hkp_PREF_FORMAT_COLOR,
#       hkp_c_ColorDefault,
#       hkp_c_ColorCode,
#       hkp_c_ColorName,
#       hkp_c_FormatTag_Color,
#       hkp_f_GetColor,
#       hkp_f_Unformat
#
#   30-Oct-1999: Version 1.0.10 / Build 282
#     + hkp_c_FormatTag_Token,
#       hkp_PREF_FORMAT_QUOTE_SKIP_OPTIONAL,
#       hkp_c_DefaultQuoteChar,
#       hkp_c_DefaultQuoteStr,
#       hkp_c_FormatTag_QuoteReq,
#       hkp_c_FormatTag_QuoteOpt,
#       hkp_f_FormatQuote,
#       hkp_PREF_FORMAT_QUOTE,
#       hkp_c_QuoteDefault,
#       hkp_c_QuoteSingle,
#       hkp_c_QuoteDouble
#
#   23-Oct-1999: Version 1.0.9 / Build 280
#     * "Changed hkp_c_CaseNoPref to hkp_c_CaseDefault"
#     * "Changed hkp_PREF_CASE_TAGS to hkp_PREF_CASE_TAG"
#     + hkp_f_CaseEvent,
#       hkp_f_CaseProperty,
#       hkp_PREF_CASE_VALUE,
#       hkp_PREF_CASE_ENTITY,
#       hkp_PREF_CASE_EVENT,
#       hkp_PREF_CASE_PROPERTY,
#       hkp_PREF_AUTHOR_NAME,
#       hkp_PREF_AUTHOR_COMPANY,
#       hkp_PREF_AUTHOR_WEBSITE,
#       hkp_PREF_AUTHOR_EMAIL,
#       hkp_PREF_AUTHOR_COMMENTS,
#       hkp_MODE_PREPROCESS_FORMAT_TAGS,
#       hkp_c_FormatTag_NormalText,
#       hkp_c_FormatTag_Tag,
#       hkp_c_FormatTag_Attr,
#       hkp_c_FormatTag_Value,
#       hkp_c_FormatTag_Entity,
#       hkp_c_FormatTag_Event,
#       hkp_c_FormatTag_Property
#
#   11-Oct-1999: Version 1.0.8 / Build 278
#     + hkp_MODE_ADD_MENU_SHORTCUTS,
#       hkp_MODE_ICON,
#       hkp_c_MODE_ICON_RES,
#       hkp_c_MODE_ICON_DATA,
#       hkp_c_MODE_ICON_FILE,
#       hkp_f_CaseTag,
#       hkp_f_CaseAttr,
#       hkp_f_CaseValue,
#       hkp_f_CaseEntity
#
#   30-Aug-1999: Version 1.0.7 / Build 266
#     * "Changed hkp_STATUS_OUTLINESCOUNT to hkp_STATUS_LINES_OUT_CURRENT"
#     + hkp_STATUS_LINES_IN_CURRENT,
#       hkp_STATUS_LINES_IN_TOTAL,
#       hkp_STATUS_LINES_OUT_TOTAL,
#       hkp_STATUS_PERCENT_COMPLETED,
#       hkp_STATUS_ERRORS_COUNT,
#       hkp_STATUS_WARNINGS_COUNT,
#       hkp_STATUS_PROGRESS_MESSAGE,
#       hkp_c_MODE_OUTPUT_EDITOR
#
#   15-Jul-1999: Version 1.0.6 / Build 252
#     + hkp_OWNER_WINDOW_HANDLE,
#       hkp_MODE_DEBUG_PLUGIN,
#       hkp_PREF_SHORT_MENUS,
#       hkp_PREF_MENU_HEIGHT,
#       hkp_PREF_CASE_TAGS,
#       hkp_PREF_CASE_ATTR,
#       hkp_FILE_TYPE_FILTER_DOCS,
#       hkp_FILE_TYPE_FILTER_IMAGES,
#       hkp_FILE_TYPE_FILTER_DEFAULT,
#       hkp_PATH_ROOT,
#       hkp_PATH_PLUGINS,
#       hkp_PATH_LAST_OPEN,
#       hkp_PATH_LAST_SAVE,
#       hkp_PROXY_ADDRESS,
#       hkp_PROXY_PORT,
#       hkp_PROXY_NAME,
#       hkp_PROXY_PASSWORD,
#       hkp_c_CaseUpper,
#       hkp_c_CaseLower,
#       hkp_c_CaseNoPref
#
#   02-Jul-1999: Version 1.0.4 / Build 250
#     + HKP_m_Add_NameVerSectDescHint,
#       HKP_m_Add_NameVerSectDescHintIcon,
#       hkp_f_regexReplace,
#       hkp_MODE_IN_TAG_AT_CURSOR,
#       hkp_c_MODE_OUTPUT_CURRENTWORD,
#       hkp_c_MODE_OUTPUT_CURRENTTAG,
#       hkp_INPUT_TAG_AT_CURSOR,
#       hkp_f_statbarPushMsg,
#       hkp_f_statbarPopMsg,
#       hkp_f_msgwinClearAll,
#       hkp_f_msgwinAdd
#
#   26-Jun-1999: Version 1.0.3 / Build 250
#     + hkp_MODE_IN_FILE,
#       hkp_INPUT_FILE,
#       hkp_MODE_IN_FILE_EXT,
#       hkp_MODE_IN_FILE_DELETE,
#       hkp_f_httpPostMPFD,
#       hkp_f_OpenBrowser,
#       hkp_f_GetTempFileName,
#       hkp_f_GetTempFileNameExt,
#       hkp_f_regexSplitExt,
#       hkp_f_regexFound,
#       hkp_f_regexGather
#